Configuration (INI) Files

Only the system administrator should change parameter values in configuration (INI) files since these kind of changes interfere in and have a great impact in the Automation Engine system. Also, configuration files can contain sensitive information. Make sure that only authorized users can access them.

Notes:

  • You must restart your computer after changing INI file parameters.

    Exception: No restart is required after changing values in the [HOST] section of an agent's INI file.

  • It is recommended to use host names instead of IP addresses to make configuring and managing your network easier. However, the Automation Engine can handle both, IP addresses (IPv4 and IPv6) and host names.

  • IPv6 link-local addresses are not supported. Link-local addresses for IPv4 are defined in the address block 169.254.0.0/16 in CIDR notation. In IPv6, they are assigned the address block fe80::/64. The AE cannot route these addresses because it does not save the interface. For example, fe80::153a:9938:b170:63f0%23. The interface for this IP address is %23.

  • All INI files are read as UTF-8 encoded, regardless of the version:

    • You can use Unicode characters for paths for the temp folder and so on, for example, c:\tämp

    • UTF-8 is a character superset of the legacy encoding character set, even the file content of older INI files can be read. If for any reason it is not possible to read the content as UTF-8 encoded, the INI file is read/interpreted in ANSI.

    • Code page settings in Jobs (JOBS), File Transfers (JOBF), and script function overrule INI file settings.

This page includes the following:

Overview

The definition of certain parameters is mandatory when installing and configuring a new Automation Engine system. These parameters apply to the following topics:

  • System name
  • Definition of server processes and assignment of port numbers
  • Names and port numbers of agents
  • Names of log, trace and message files
  • Variable entries

Note: Use trace flags that activate program analysis only in close cooperation with our support department. For more information, see Support.

All entries must correspond to your system environment and reflect the requirements of the Automation Engine system that you are setting up.

More information:

System Name

The system name identifies a complete AE environment. The Automation Engine and the Agents of an AE environment must use the same system name. This name is limited to 8 characters and the values allowed are upper-case letters A to Z, numbers and "_".

If you want to use a new system name, you must also adjust it in all relevant INI files (Automation Engine and agents). To do so, end all running tasks (events, schedules, workflows etc.) before you start because they would not continue after you have changed the system name.

Important! When using a z/OS Agent in combination with SMF technology note that the z/OS Event Monitor converts the character "_" to "#" when it is used in the system name.

Server Processes

The Automation Engine automatically generates server process using the following components:

  • Name of the AE system
  • Number sign (#)
  • Type of server process
  • Three-digit process number that is unique for each process type

Example

UC4G#CP001

The INI file of the Automation Engine comprises the definitions of server processes including their process numbers. It also includes the port numbers that are assigned to the server processes. They must be unique throughout the entire AE system. For more information, see Automation Engine.

Agent Names

Agent names are limited to 32 characters. The values allowed are A-Z, 0-9, _, ., $, @, - and #. You can define the Agent name using the name= parameter in the [GLOBAL] section of INI file of the relevant Agent. For more information, see Agents.

If the name= parameter is not defined in the INI file of the respective Agent, the host name is used by default.

Database Access

You can define the connection to the database in the [ODBC] section of the INI files of the Automation Engine and the Utilities. In this case, make sure you obfuscate the corresponding password using the UCYBCRYP.EXE program.

More information:

Environment Variables

You can also use environment variables to define the parameters of the INI file of the Automation Engine (ucsrv.ini). These variables allow you to substitute values in the INI file of the Automation Engine without overwriting the INI file itself. For more information, see Automation Engine.

Note: You can substitute whole keys of the INI file but not a complete section.

Each environment variable for the AE uses the syntax pattern ${PREFIX_SECTION_KEY:DEFINITION}:

  • PREFIX: AUTOMIC

    Constant prefix for these environment variables.

  • SECTION:

    Defines the section of the INI file in which the key you want to define is located.

  • KEY:

    Specifies the key you want to substitute.

  • DEFINITION:

    The value that you want to define for the key.

Example

${AUTOMIC_GLOBAL_SYSTEM:AUTOMIC}

This environment variable sets AUTOMIC as the value of the system= key in the [GLOBAL] section of the INI file of the Automation Engine.

Environment Variables in Container-Based Systems

In the Automic Automation Kubernetes Edition, you must use environment variables to define the parameters of the INI file of the Automation Engine.

You can set the environment variables using the values.yaml file before and after the installation. Once your instance has been provisioned, you can also use the ae-properties and awi-properties section of the configmap to make changes.

More information:

See also: